// Magic Software, Inc.
// http://www.magic-software.com
// Copyright (c) 2000, All Rights Reserved
//
// Source code from Magic Software is supplied under the terms of a license
// agreement and may not be copied or disclosed except in accordance with the
// terms of that agreement.  The various license agreements may be found at
// the Magic Software web site.  This file is subject to the license
//
// RESTRICTED USE SOURCE CODE
// http://www.magic-software.com/License/restricted.pdf

#ifndef MGCIMAGE_H
#define MGCIMAGE_H

#include "MgcObject.h"


class MgcImage : public MgcObject
{
    MgcDeclareRTTI;
    MgcDeclareStream;

public:
    enum Type
    {
        IT_RGBA4444,
        IT_RGB888,
        IT_RGBA5551,
        IT_RGBA8888,
        IT_QUANTITY
    };

    // Construction and destruction.  MgcImage accepts responsibility for
    // deleting the input array.
    MgcImage (Type eType, unsigned int uiWidth, unsigned int uiHeight,
        unsigned char* aucData);

    virtual ~MgcImage ();

    // Load/save Magic image files.  This simple file type is designed to
    // avoid having the engine provide a generic file converter library.  The
    // file header is a non-null-terminated ASCII string (starts with 'M',
    // ends with '#'),
    //     Magic3D Image File#t#w#h#
    // where t is in {0,..,IT_QUANTITY-1} (the values of the enumerations in
    // 'Type'), w is the unsigned integer width, and h is the unsigned
    // integer height.  Immediately following the last # is the unsigned
    // character data.  There must be ms_auiBytesPerPixel[t]*w*h bytes of
    // data.
    //
    // A few error conditions can arise.  On any error condition, the image
    // members are set just as in the default constructor.  The conditions
    // are:
    //   1. file does not exist
    //   2. file exists, but not a Magic image file
    //   3. file is Magic image, but
    //      a. t is not in {0,..,IT_QUANTITY-1}
    //      b. w is zero
    //      c. h is zero
    //      d. the byte quantity for the data is incorrect
    //
    // I will use the extension ".mif" for Magic image files, but the load
    // and save routines do not depend on this.
    MgcImage (const char* acFilename);
    bool Save (const char* acFilename);


    Type GetType () const;
    unsigned int GetBytesPerPixel () const;

    unsigned int GetWidth () const;
    unsigned int GetHeight () const;
    unsigned int GetQuantity () const;

    unsigned char* GetData () const;
    unsigned char* operator() (unsigned int uiIndex);

protected:
    MgcImage ();
    void SetDefault ();

    Type m_eType;
    unsigned int m_uiWidth, m_uiHeight, m_uiQuantity;
    unsigned char* m_aucData;

    static unsigned int ms_auiBytesPerPixel[IT_QUANTITY];
};

MgcSmartPointer(MgcImage);
MgcRegisterStream(MgcImage);
#include "MgcImage.inl"

#endif
